feat(workflows): add sample 'execute_with_arguments' and update 'conftest.py' #13290
Conversation
…ts so they work well together
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hello @eapl-gemugami, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
Summary of Changes
This pull request introduces a new sample, workflows_api_quickstart_pass_data_in_execution_request, which demonstrates how to pass arguments to a Cloud Workflow execution. It also updates the Workflow YAML definition to accept optional arguments while maintaining compatibility with previous samples. Additionally, the PR refactors existing tests and the conftest.py file to accommodate the new functionality.
Highlights
- Feature: Introduces a new sample,
pass_data_in_execution_request.py, showcasing how to pass data to a workflow execution via an argument. - Enhancement: Updates the Workflow YAML definition (
myFirstWorkflow.workflows.yaml) to accept optional arguments, ensuring backward compatibility. - Refactor: Refactors existing tests and
conftest.pyto support the new sample and argument passing functionality.
Changelog
Click here to see the changelog
- workflows/cloud-client/README.md
- Updates the README to reflect the correct location of the workflow YAML file and adjusts the expected output description.
- Changes the compatible Python version to 3.9+.
- workflows/cloud-client/conftest.py
- Modifies
workflow_idfixture scope tofunctionto ensure unique workflow IDs for each test. - Updates the workflow creation logic to use a base workflow ID and append a UUID for uniqueness.
- Updates
workflow_existsfunction to accept a workflow_id parameter.
- Modifies
- workflows/cloud-client/main_test.py
- Changes
max_timetomax_triesin thebackoffdecorator for thetest_workflow_executionfunction.
- Changes
- workflows/cloud-client/myFirstWorkflow.workflows.yaml
- Updates the copyright year to 2025.
- Modifies the workflow definition to accept an optional
searchTermargument, defaulting to the day of the week in Amsterdam if not provided.
- workflows/cloud-client/pass_data_in_execution_request.py
- Adds a new file containing the
execute_workflow_with_argumentfunction, which demonstrates how to pass arguments to a workflow execution.
- Adds a new file containing the
- workflows/cloud-client/pass_data_in_execution_request_test.py
- Adds a new test file for the
execute_workflow_with_argumentfunction, verifying the successful execution and argument passing.
- Adds a new test file for the
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
A workflow's gentle stream,
Data flows, a waking dream,
Arguments passed on,
Execution begun,
A digital paradigm.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
product-auto-label
bot
added
samples
There was a problem hiding this comment.
Code Review
This pull request introduces a new sample for passing data in execution requests, updates the workflow YAML definition, and refactors existing tests. The changes look good overall, but there are a few areas that could be improved for clarity and maintainability.
Summary of Findings
- Workflow ID Generation: The workflow ID generation in
conftest.pycould be simplified by directly incorporating the base name into the UUID string, improving readability. - README Update: The README update includes a change to the expected output, which is good. However, it could be more explicit about the dependency on the weekday in Amsterdam.
- Copyright Year: The copyright year in
myFirstWorkflow.workflows.yamlandpass_data_in_execution_request.pyhas been updated to 2025. Ensure this is the correct and intended year.
Merge Readiness
The pull request is almost ready for merging. Please address the comments regarding workflow ID generation and copyright year. I am unable to directly approve the pull request, and other reviewers should review and approve this code before merging.
eapl-gemugami
changed the title
snippet-bot
bot
removed
the
snippet-bot:force-run
|
Here is the summary of changes. You are about to add 3 region tags.
This comment is generated by snippet-bot.
|
eapl-gemugami
changed the title
|
LGTM! |
eapl-gemugami
changed the title
eapl-gemugami
changed the title
|
LGTM! Just a couple of nits in the readme file |
PR review GoogleCloudPlatform#13290 (comment) - Replace texts in README.md
There was a problem hiding this comment.
Apologies, I missed this in my earlier review. Pls replace "Google Cloud Platform" with just "Google Cloud" in the readme file per https://cloud.google.com/guides/style/branding-list#cloud-name-list.
|
cc @OremGLG @hivanalejandro @alarconesparza this brand guideline that 'camiekim' mentioned could be useful for your samples. |
eapl-gemugami
added
the
kokoro:force-run
kokoro-team
removed
the
kokoro:force-run
eapl-gemugami
deleted the
paradalicea/feat/workflows/create-sample/execution-pass-data/b-391200147
branch
Description
Fixes b/391200147
workflows_execute_with_argumentsand start migration ofworkflows_execute_without_argumentsconftest.pyChecklist
nox -s py-3.9(see Test Environment Setup)nox -s lint(see Test Environment Setup)